ostree-repo: Clarify error behaviour of remote option getters

Clarify the documentation for functions like
ostree_repo_get_remote_boolean_option(), stating what out_value will be
set to on error.

Signed-off-by: Philip Withnall <withnall@endlessm.com>
Closes: #676
Approved by: cgwalters

diff --git a/src/libostree/ostree-repo.c b/src/libostree/ostree-repo.c
index 47e95ae4121851943eaab21d0466e37324a28a3e..e7cbb16d89696d0984f3d7954911c7cb3bf9abbb 100644 (file)
--- a/src/libostree/ostree-repo.c
+++ b/src/libostree/ostree-repo.c
@@ -284,7 +284,7 @@ _ostree_repo_remote_name_is_file (const char *remote_name)
  * OSTree remotes are represented by keyfile groups, formatted like:
  * `[remote "remotename"]`. This function returns a value named @option_name
  * underneath that group, or @default_value if the remote exists but not the
- * option name.
+ * option name.  If an error is returned, @out_value will be set to %NULL.
  *
  * Returns: %TRUE on success, otherwise %FALSE with @error set
  */
@@ -360,8 +360,9 @@ ostree_repo_get_remote_option (OstreeRepo  *self,
  *
  * OSTree remotes are represented by keyfile groups, formatted like:
  * `[remote "remotename"]`. This function returns a value named @option_name
- * underneath that group, and returns it as an zero terminated array of strings.
- * If the option is not set, @out_value will be set to %NULL.
+ * underneath that group, and returns it as a zero terminated array of strings.
+ * If the option is not set, or if an error is returned, @out_value will be set
+ * to %NULL.
  *
  * Returns: %TRUE on success, otherwise %FALSE with @error set
  */
@@ -435,7 +436,8 @@ ostree_repo_get_remote_list_option (OstreeRepo   *self,
  * OSTree remotes are represented by keyfile groups, formatted like:
  * `[remote "remotename"]`. This function returns a value named @option_name
  * underneath that group, and returns it as a boolean.
- * If the option is not set, @out_value will be set to @default_value.
+ * If the option is not set, @out_value will be set to @default_value. If an
+ * error is returned, @out_value will be set to %FALSE.
  *
  * Returns: %TRUE on success, otherwise %FALSE with @error set
  */